home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bfx13.zip / BFX.DOC < prev    next >
Text File  |  1992-02-14  |  13KB  |  463 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                                          BFX
  27.  
  28.                       Copyright (c) 1992 Richard D. Fothergill
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.                                                       Richard D. Fothergill
  57.                                                            the Oak Hill BBS
  58.                                                           141 Oak Hill Road
  59.                                                       Pittsfield, MA  01201
  60.                                                   Data/FAX - (413) 499-7245
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.           WHAT IS BFX?
  74.  
  75.           When  I purchased my ZyXEL  U-1496 Modem/Fax I wanted an easy way
  76.           to  be able to accept fax and modem calls on the same line.  This
  77.           would allow me to continue to operate my BBS software and be in a
  78.           position  to receive  faxes.  I  tried BinkleyTerm and FrontDoor.
  79.           Both  excellent programs, but  way more than  I needed or wanted,
  80.           not  having a  need for  network mailers  or a  built in terminal
  81.           program.   I wanted  something simple,  small, easy  to setup and
  82.           maintain.  Thus the beginning of BFX.
  83.  
  84.           WHAT CAN I DO WITH BFX?
  85.  
  86.           You  run BFX instead  of your BBS  software.  BFX will answer the
  87.           phone,  decide  what  the  incoming  call  is  and  exit  with an
  88.           errorlevel  which you  can  use in  a  batch file  for subsequent
  89.           operations.   A BBS  call will also  create a  batch file to call
  90.           your  BBS software.  In addition  you can program up to 10 events
  91.           with  a preset time  of execution and  exit errorlevel.  When BFX
  92.           encounters  one of  these it  will  exit with  your predetermined
  93.           errorlevel.   Again, you control further processing in your batch
  94.           file.
  95.  
  96.           DISCLAIMER
  97.  
  98.           IN  NO EVENT WILL  I BE LIABLE  TO YOU FOR ANY DAMAGES, INCLUDING
  99.           ANY   LOST  PROFITS,   LOST  SAVINGS   OR  OTHER   INCIDENTAL  OR
  100.           CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE
  101.           THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.           BFX                                               -1-
  129.           Copr (c) 1992 Richard D. Fothergill
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           INSTALLATION
  140.  
  141.           There  are three files that you must create to run BFX.  They are
  142.           BBS.BAT, BFX.CFG, BFX.EVT.  I will discuss these individually.
  143.  
  144.           BBS.BAT
  145.  
  146.           This batch file is the heart of your BBS/FAX system.  It controls
  147.           all  activity and  execution.  You  do not  have to  use the name
  148.           BBS.BAT,  it can be any  name of your choosing.  The following is
  149.           the BBS.BAT file I use.
  150.  
  151.           @ECHO OFF
  152.           :loop
  153.             cls
  154.             BFX
  155.             if errorlevel 40 goto event
  156.             if errorlevel 30 goto fax
  157.             if errorlevel 20 goto spit
  158.             if errorlevel 10 goto spitl
  159.             if errorlevel  0 goto end
  160.           :event
  161.             sfmaint
  162.             goto loop
  163.           :fax
  164.             rcvfax 1 f:\sf\fax
  165.             goto loop
  166.           :spit
  167.             call bbsexe
  168.             goto loop
  169.           :spitl
  170.             spitfire 0
  171.             goto loop
  172.           :end
  173.  
  174.           There are four hardcoded errorlevels.  They are:
  175.  
  176.                0 - Terminate
  177.               10 - Local Logon
  178.               20 - BBS/Modem Connection
  179.               30 - FAX Connection
  180.  
  181.           The  loop: label is where execution of the batch file will return
  182.           to  after any activity other  than a normal exit.  BFX is started
  183.           and  awaits a caller.  If a call is received or a scheduled event
  184.           occurs  BFX will exit with the corresponding errorlevel.  Control
  185.           then returns to this batch file.
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.           BFX                                               -2-
  195.           Copr (c) 1992 Richard D. Fothergill
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.           BFX.CFG
  206.  
  207.           This is the configuration file you setup to inform BFX of certain
  208.           parameters  it  needs to  function.   The following  is  a sample
  209.           configuration file.
  210.  
  211.           CM=2
  212.           BA=38400
  213.           PA=N
  214.           DA=8
  215.           SB=1
  216.           MI=AT&FM0V1E0H0S2=1X7#B1+FCLASS=6
  217.           AS=ATA
  218.           HY=ATH0
  219.           HN=ATH1
  220.           MR=ATZ
  221.           BB=SPITFIRE
  222.           BP=
  223.           CP=/C
  224.           EC=/E
  225.           ST=120
  226.           RC=2
  227.           LM=>> BFX >> logging on to...
  228.  
  229.           There  are no spaces  allowed in this  file between the parameter
  230.           and  the = sign.  The items should appear in the sequence listed.
  231.           The parameters and the meanings are a follows:
  232.  
  233.           CM  The communications port you have your modem on.
  234.  
  235.           BA  The baud rate to initialize your modem to.
  236.  
  237.           PA  Parity
  238.  
  239.           DA  Data length
  240.  
  241.           SB  Stop Bits
  242.  
  243.           MI  Your initialization string for modem/fax reception.
  244.  
  245.           AS  Modem answer string.
  246.  
  247.           HY  Modem onhook string.
  248.  
  249.           HN  Modem offhook string.
  250.  
  251.           MR  Modem reset string.
  252.  
  253.           BB  The name you would like placed in the BBSEXE.BAT file.
  254.  
  255.           BP  The text you would like to preceed the baud rate parameter in
  256.               the BBSEXE.BAT file.
  257.  
  258.  
  259.  
  260.           BFX                                               -3-
  261.           Copr (c) 1992 Richard D. Fothergill
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.           CP  The text you would like to proceed the com port parameter in
  272.               the BBSEXE.BAT file.  Spitfire specifies that the parameter
  273.               read /C<comport>.  Check your BBS software.
  274.  
  275.           EC  The text you would like in then BBSEXE.BAT file to notify
  276.               your BBS software of an error correcting connection.
  277.  
  278.           ST  Sleep time out seconds.  This is the amount of time BFX
  279.               will wait before blanking the screen.  A display of the
  280.               program name and current time will appear at random locations
  281.               to remind you of the program running.  If ST=0 then screen
  282.               blanking is disabled.
  283.  
  284.           RC  The number of rings on which you would like BFX to answer
  285.               the call.
  286.  
  287.           LM  Log on message.  This is sent to the caller just before BFX
  288.               exits on a modem connection.
  289.  
  290.           BFX.EVT
  291.  
  292.           This file is used to define your events.  It is a comma delimited
  293.           file consisting of three parameters.  The first is a 40 character
  294.           description.  This will be written to the log file when the event
  295.           is executed.  The second is the time you want the event to occur.
  296.           The format is HH:MM and is in 24 hour time.  The last item is the
  297.           errorlevel.   This can  be any  integer value  except one  of the
  298.           hardcoded  errorlevels mentioned earlier.  Each event must appear
  299.           on  a separate line in the file and you are limited to 10 events.
  300.           A typical line in the event file is as follows:
  301.  
  302.               DAILY MAINTENANCE,01:00,40
  303.  
  304.           This  line would cause  BFX to  exit with an  errorlevel of 40 at
  305.           1:00 am.
  306.  
  307.           FILES CREATED BY BFX
  308.  
  309.           There  are three  files  created by  BFX.   A discussion  of each
  310.           follows.
  311.  
  312.           BFX.LOG
  313.  
  314.           If  this file  is not  found at  start-up BFX  creates a new one.
  315.           Each  time an activity occurs,  an entry is written to this file.
  316.           The entry will consist of the date, time, description of activity
  317.           and  either the errorlevel for an event or the CONNECT string for
  318.           a  modem connection.  Local logons  are not recorded in the file.
  319.           This  file has  no interaction with  your BBS  log file.  A modem
  320.           connection  may be made  and control passed  to your BBS software
  321.           and  the user might  hang up with  out logging on.  In this case,
  322.           there  would still be  a record of  the connection in the BFX.LOG
  323.           but in all probability, not in your BBS log.
  324.  
  325.  
  326.           BFX                                               -4-
  327.           Copr (c) 1992 Richard D. Fothergill
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.           BFX.STS
  338.  
  339.           This  is a  file used  strictly by  BFX.  Each  time BFX releases
  340.           control  back to DOS, BFX writes control data to this file.  When
  341.           it  restarts it  reads this  information  back in.   Although not
  342.           required,  it is suggested  that each time  you erase the BFX.LOG
  343.           file  to  clear  that,  you  erase  BFX.STS  to  reset  the  call
  344.           statistics.   You do not have  to recreate these files.  BFX will
  345.           create new ones if existing files are not found.
  346.  
  347.           BBSEXE.BAT
  348.  
  349.           When  a BBS call is  received, BFX will create a batch file which
  350.           contains  the name (BB),  followed by the  baud rate prefix (BP),
  351.           baud  rate, com  port prefix  (CP), com  port (CM)  and the error
  352.           correcting  string  (EC) .   The  parameters you  specify  in the
  353.           configuration  file should allow  you to  construct an entry that
  354.           will  allow you  to start your  BBS software.   The format of the
  355.           line in BBSEXE using the configuration parameters is:
  356.  
  357.               [BB] [BP]<baud rate> [CP][CM] [EC]
  358.               SPITFIRE 14400 /C2 /E
  359.  
  360.  
  361.           GENERAL DISCUSSION
  362.  
  363.           As  you can  see  from my  sample  BBS.BAT file  I  am set  up as
  364.           follows.
  365.  
  366.           Errorlevel                Action
  367.  
  368.               0         Normal program exit.  Modem reset.
  369.              10         Local logon to BBS.  Spitfire requires that you
  370.                         call it with a baud rate of 0 to let it know that
  371.                         it is a local log on and not try to detect a
  372.                         carrier.
  373.              20         Remote call BBS logon.  Spitfire requires that you
  374.                         call it with a baud rate and com port to notify it
  375.                         that a connection has already been made and to
  376.                         proceed to the user log on.
  377.              30         Remote call FAX transmission.  The batch file
  378.                         passes control to ZyXEL's RCVFAX program which also
  379.                         assumes a connection has been established.
  380.              40         User specified event.  I have this set to occur at
  381.                         1:00 am.  This is routine BBS maintenance.  Please
  382.                         remember, running in a system such a this, in all
  383.                         probability events scheduled in your BBS software
  384.                         will never occur.  Your BBS software is not the
  385.                         program controlling the flow, BFX is, so events
  386.                         should be schedule through BFX.
  387.  
  388.  
  389.  
  390.  
  391.  
  392.           BFX                                               -5-
  393.           Copr (c) 1992 Richard D. Fothergill
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.           MENU AND HOT KEYS
  404.  
  405.           From  the Waiting  for Caller  screen you  have two  possible key
  406.           strokes.   Alt-X will close BFX and execute a normal exit.  Alt-M
  407.           will bring up a pop menu with the following selections available:
  408.  
  409.               View Activity Log
  410.               Local Logon
  411.               Drop to DOS
  412.               Terminate BFX
  413.  
  414.           Within  this  menu  your  mouse  will  be  active  to  locate the
  415.           highlight  bar or you  can use the  arrow keys.  Either press the
  416.           left mouse button or the enter key to make a selection.  Pressing
  417.           the  right mouse  button or  the Esc  key will  return you to the
  418.           Waiting for Caller screen.
  419.  
  420.           View  Activity Log  - This  selection  will pop  up a  window and
  421.           display  the BFX.LOG file.  All  the direction keys are active as
  422.           well  as the mouse.  Press  the Esc key or the right mouse button
  423.           to return to the menu.
  424.  
  425.           Local Logon - This will exit the system with an errorlevel of 10.
  426.           This  does not  have to  be a  local log  on.  You  can have your
  427.           BBS.BAT file execute any program you wish or none at all.
  428.  
  429.           Drop  to DOS  - Self explanatory.   The DOS  prompt is amended to
  430.           remind you to EXIT back to the BFX menu.
  431.  
  432.           Terminate  BFX - Same as  the Alt-X key press.  Executes a normal
  433.           exit back to dos.
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.           BFX                                               -6-
  459.           Copr (c) 1992 Richard D. Fothergill
  460.  
  461.  
  462.  
  463.